<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class SoapClientFactory</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class SoapClientFactory</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Base class for all SOAP client factories of Ads client libraries.</p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_common---src---Google---Api---Ads---Common---Lib---SoapClientFactory.php.html">/common/src/Google/Api/Ads/Common/Lib/SoapClientFactory.php</a> (line <span class="field">40</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsSoapClientFactory.html">AdWordsSoapClientFactory</a></td>
					<td>
											Factory class for SOAP clients for the AdWords API.
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																												
												<div class="method-definition">
											<span class="method-result">SoapClientFactory</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../../GoogleApiAdsCommon/Lib/AdsUser.html">AdsUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$version</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$server</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$productName</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$headerOverrides</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#DoRequireOnce" title="details" class="method-name">DoRequireOnce</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../GoogleApiAdsCommon/Lib/AdsSoapClient.html">AdsSoapClient</a></span>
										<a href="#GenerateServiceClient" title="details" class="method-name">GenerateServiceClient</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../GoogleApiAdsCommon/Lib/AdsSoapClient.html">AdsSoapClient</a></span>
										<a href="#GenerateSoapClient" title="details" class="method-name">GenerateSoapClient</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../GoogleApiAdsCommon/Lib/AdsUser.html">AdsUser</a></span>
										<a href="#GetAdsUser" title="details" class="method-name">GetAdsUser</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#GetProductName" title="details" class="method-name">GetProductName</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#GetServer" title="details" class="method-name">GetServer</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#GetServiceLocation" title="details" class="method-name">GetServiceLocation</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#GetVersion" title="details" class="method-name">GetVersion</a>
										()
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The constructor called by any sub-class.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">SoapClientFactory</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../../GoogleApiAdsCommon/Lib/AdsUser.html">AdsUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$version</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$server</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$productName</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$headerOverrides</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../GoogleApiAdsCommon/Lib/AdsUser.html">AdsUser</a></span>
				<span class="var-name">$user</span><span class="var-description">: the user which the client will use for credentials</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$version</span><span class="var-description">: the version to generate clients for</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$server</span><span class="var-description">: the server to generate clients for</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$productName</span><span class="var-description">: the product name (i.e. adwords)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$headerOverrides</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../GoogleApiAdsAdWords/Lib/AdWordsSoapClientFactory.html#method__construct">AdWordsSoapClientFactory::__construct()</a>
								: The constructor for the AdWords API SOAP client factory.
							</li>
				</ul>
	</div>
<a name="methodDoRequireOnce" id="DoRequireOnce"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">DoRequireOnce</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initiates a require_once for the service.</p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			DoRequireOnce
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$serviceName</span><span class="var-description">: the service to instantiate</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../GoogleApiAdsAdWords/Lib/AdWordsSoapClientFactory.html#methodDoRequireOnce">AdWordsSoapClientFactory::DoRequireOnce()</a>
								: Initiates a require_once for the service.
							</li>
				</ul>
	</div>
<a name="methodGenerateServiceClient" id="GenerateServiceClient"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GenerateServiceClient</span> (line <span class="line-number">97</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates the SOAP service client without the proper headers set yet.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the SOAP service client</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../GoogleApiAdsCommon/Lib/AdsSoapClient.html">AdsSoapClient</a></span>
		<span class="method-name">
			GenerateServiceClient
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$serviceName</span><span class="var-description">: the service to create a client for</span>			</li>
				</ul>
		
			
	</div>
<a name="methodGenerateSoapClient" id="GenerateSoapClient"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GenerateSoapClient</span> (line <span class="line-number">79</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a SOAP client for the given service name. Generates a user level  error if this instalation of PHP does not have the extension for SOAP  installed.</p>
	<ul class="tags">
				<li><span class="field">return:</span> an instantiated SOAP client</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../GoogleApiAdsCommon/Lib/AdsSoapClient.html">AdsSoapClient</a></span>
		<span class="method-name">
			GenerateSoapClient
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$serviceName</span><span class="var-description">: the name of the service to generate a client for</span>			</li>
				</ul>
		
			
	</div>
<a name="methodGetAdsUser" id="GetAdsUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetAdsUser</span> (line <span class="line-number">185</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the user associated with this factory.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the user associated with this factory</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../GoogleApiAdsCommon/Lib/AdsUser.html">AdsUser</a></span>
		<span class="method-name">
			GetAdsUser
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetProductName" id="GetProductName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetProductName</span> (line <span class="line-number">209</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the product name associated with this factory.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the product name associated with this factory</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			GetProductName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetServer" id="GetServer"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetServer</span> (line <span class="line-number">201</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the server associated with this factory.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the server associated with this factory</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			GetServer
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetServiceLocation" id="GetServiceLocation"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetServiceLocation</span> (line <span class="line-number">174</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the end-point location of the service.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the end-point location of the service.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			GetServiceLocation
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$serviceName</span><span class="var-description">: the service to instantiate</span>			</li>
				</ul>
		
			
	</div>
<a name="methodGetVersion" id="GetVersion"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetVersion</span> (line <span class="line-number">193</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the version associated with this factory.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the version associated with this factory</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			GetVersion
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>